package config import ( "errors" "io/ioutil" "log" "os" "github.com/TwinProduction/gatus/alerting" "github.com/TwinProduction/gatus/alerting/provider" "github.com/TwinProduction/gatus/core" "github.com/TwinProduction/gatus/k8s" "github.com/TwinProduction/gatus/security" "gopkg.in/yaml.v2" ) const ( // DefaultConfigurationFilePath is the default path that will be used to search for the configuration file // if a custom path isn't configured through the GATUS_CONFIG_FILE environment variable DefaultConfigurationFilePath = "config/config.yaml" // DefaultFallbackConfigurationFilePath is the default fallback path that will be used to search for the // configuration file if DefaultConfigurationFilePath didn't work DefaultFallbackConfigurationFilePath = "config/config.yml" // DefaultAddress is the default address the service will bind to DefaultAddress = "0.0.0.0" // DefaultPort is the default port the service will listen on DefaultPort = 8080 // DefaultContextRoot is the default context root of the web application DefaultContextRoot = "/" ) var ( // ErrNoServiceInConfig is an error returned when a configuration file has no services configured ErrNoServiceInConfig = errors.New("configuration file should contain at least 1 service") // ErrConfigFileNotFound is an error returned when the configuration file could not be found ErrConfigFileNotFound = errors.New("configuration file not found") // ErrConfigNotLoaded is an error returned when an attempt to Get() the configuration before loading it is made ErrConfigNotLoaded = errors.New("configuration is nil") // ErrInvalidSecurityConfig is an error returned when the security configuration is invalid ErrInvalidSecurityConfig = errors.New("invalid security configuration") config *Config ) // Config is the main configuration structure type Config struct { // Debug Whether to enable debug logs Debug bool `yaml:"debug"` // Metrics Whether to expose metrics at /metrics Metrics bool `yaml:"metrics"` // DisableMonitoringLock Whether to disable the monitoring lock // The monitoring lock is what prevents multiple services from being processed at the same time. // Disabling this may lead to inaccurate response times DisableMonitoringLock bool `yaml:"disable-monitoring-lock"` // Security Configuration for securing access to Gatus Security *security.Config `yaml:"security"` // Alerting Configuration for alerting Alerting *alerting.Config `yaml:"alerting"` // Services List of services to monitor Services []*core.Service `yaml:"services"` // Kubernetes is the Kubernetes configuration Kubernetes *k8s.Config `yaml:"kubernetes"` // Web is the configuration for the web listener Web *webConfig `yaml:"web"` } // Get returns the configuration, or panics if the configuration hasn't loaded yet func Get() *Config { if config == nil { panic(ErrConfigNotLoaded) } return config } // Load loads a custom configuration file // Note that the misconfiguration of some fields may lead to panics. This is on purpose. func Load(configFile string) error { log.Printf("[config][Load] Reading configuration from configFile=%s", configFile) cfg, err := readConfigurationFile(configFile) if err != nil { if os.IsNotExist(err) { return ErrConfigFileNotFound } return err } config = cfg return nil } // LoadDefaultConfiguration loads the default configuration file func LoadDefaultConfiguration() error { err := Load(DefaultConfigurationFilePath) if err != nil { if err == ErrConfigFileNotFound { return Load(DefaultFallbackConfigurationFilePath) } return err } return nil } func readConfigurationFile(fileName string) (config *Config, err error) { var bytes []byte if bytes, err = ioutil.ReadFile(fileName); err == nil { // file exists, so we'll parse it and return it return parseAndValidateConfigBytes(bytes) } return } func parseAndValidateConfigBytes(yamlBytes []byte) (config *Config, err error) { // Expand environment variables yamlBytes = []byte(os.ExpandEnv(string(yamlBytes))) // Parse configuration file err = yaml.Unmarshal(yamlBytes, &config) if err != nil { return } // Check if the configuration file at least has services configured or Kubernetes auto discovery enabled if config == nil || ((config.Services == nil || len(config.Services) == 0) && (config.Kubernetes == nil || !config.Kubernetes.AutoDiscover)) { err = ErrNoServiceInConfig } else { // Note that the functions below may panic, and this is on purpose to prevent Gatus from starting with // invalid configurations validateAlertingConfig(config) validateSecurityConfig(config) validateServicesConfig(config) validateKubernetesConfig(config) validateWebConfig(config) } return } func validateWebConfig(config *Config) { if config.Web == nil { config.Web = &webConfig{Address: DefaultAddress, Port: DefaultPort, ContextRoot: DefaultContextRoot} } else { config.Web.validateAndSetDefaults() } } func validateKubernetesConfig(config *Config) { if config.Kubernetes != nil && config.Kubernetes.AutoDiscover { if config.Kubernetes.ServiceTemplate == nil { panic("kubernetes.service-template cannot be nil") } if config.Debug { log.Println("[config][validateKubernetesConfig] Automatically discovering Kubernetes services...") } discoveredServices, err := k8s.DiscoverServices(config.Kubernetes) if err != nil { panic(err) } config.Services = append(config.Services, discoveredServices...) log.Printf("[config][validateKubernetesConfig] Discovered %d Kubernetes services", len(discoveredServices)) } } func validateServicesConfig(config *Config) { for _, service := range config.Services { if config.Debug { log.Printf("[config][validateServicesConfig] Validating service '%s'", service.Name) } service.ValidateAndSetDefaults() } log.Printf("[config][validateServicesConfig] Validated %d services", len(config.Services)) } func validateSecurityConfig(config *Config) { if config.Security != nil { if config.Security.IsValid() { if config.Debug { log.Printf("[config][validateSecurityConfig] Basic security configuration has been validated") } } else { // If there was an attempt to configure security, then it must mean that some confidential or private // data are exposed. As a result, we'll force a panic because it's better to be safe than sorry. panic(ErrInvalidSecurityConfig) } } } func validateAlertingConfig(config *Config) { if config.Alerting == nil { log.Printf("[config][validateAlertingConfig] Alerting is not configured") return } alertTypes := []core.AlertType{ core.SlackAlert, core.MattermostAlert, core.MessagebirdAlert, core.TwilioAlert, core.PagerDutyAlert, core.CustomAlert, } var validProviders, invalidProviders []core.AlertType for _, alertType := range alertTypes { alertProvider := GetAlertingProviderByAlertType(config, alertType) if alertProvider != nil { if alertProvider.IsValid() { validProviders = append(validProviders, alertType) } else { log.Printf("[config][validateAlertingConfig] Ignoring provider=%s because configuration is invalid", alertType) invalidProviders = append(invalidProviders, alertType) } } else { invalidProviders = append(invalidProviders, alertType) } } log.Printf("[config][validateAlertingConfig] configuredProviders=%s; ignoredProviders=%s", validProviders, invalidProviders) } // GetAlertingProviderByAlertType returns an provider.AlertProvider by its corresponding core.AlertType func GetAlertingProviderByAlertType(config *Config, alertType core.AlertType) provider.AlertProvider { switch alertType { case core.SlackAlert: if config.Alerting.Slack == nil { // Since we're returning an interface, we need to explicitly return nil, even if the provider itself is nil return nil } return config.Alerting.Slack case core.MattermostAlert: if config.Alerting.Mattermost == nil { // Since we're returning an interface, we need to explicitly return nil, even if the provider itself is nil return nil } return config.Alerting.Mattermost case core.MessagebirdAlert: if config.Alerting.Messagebird == nil { // Since we're returning an interface, we need to explicitly return nil, even if the provider itself is nil return nil } return config.Alerting.Messagebird case core.TwilioAlert: if config.Alerting.Twilio == nil { // Since we're returning an interface, we need to explicitly return nil, even if the provider itself is nil return nil } return config.Alerting.Twilio case core.PagerDutyAlert: if config.Alerting.PagerDuty == nil { // Since we're returning an interface, we need to explicitly return nil, even if the provider itself is nil return nil } return config.Alerting.PagerDuty case core.CustomAlert: if config.Alerting.Custom == nil { // Since we're returning an interface, we need to explicitly return nil, even if the provider itself is nil return nil } return config.Alerting.Custom } return nil }