Documentation
¶
Index ¶
- type AlertConfig
- type AlertConfigList
- type AlertingConfig
- type ReceiverConfig
- type ReceiverConfigMap
- type ReceiverConfigSecretStatus
- type ReceiverConfigSecretStatusMap
- type SlackConfig
- type SlackConfigSecretStatus
- type UpdateAlertingConfig
- type UpdateReceiverConfigSecrets
- type UpdateReceiverConfigSecretsMap
- type UpdateSlackConfigSecrets
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AlertConfig ¶
type AlertConfig struct {
// Receiver is the name of the receiver that will handle this alert
// required: true
Receiver string `json:"receiver"`
// Alert defines the name of a predefined alert
// required: true
Alert string `json:"alert"`
}
AlertConfig defines a mapping between a pre-defined alert name and a receiver
type AlertConfigList ¶
type AlertConfigList []AlertConfig
AlertConfigList list of AlertConfig
func (AlertConfigList) AsRadixAlertAlerts ¶
func (l AlertConfigList) AsRadixAlertAlerts() []radixv1.Alert
AsRadixAlertAlerts converts list of AlertConfigs to list of alerts to be used in RadixAlert spec
type AlertingConfig ¶
type AlertingConfig struct {
// Enabled flag tells if alerting is enabled or disabled
Enabled bool `json:"enabled"`
// Ready flag tells tells if alerting is ready to be configured
// Value is always false when Enabled is false
// Vlaue is True if Enabled is true and Radix operator has processed the alert configuration
Ready bool `json:"ready"`
// Receivers map of available receivers to be mapped to alerts
Receivers ReceiverConfigMap `json:"receivers,omitempty"`
// ReceiverSecretStatus has status of required secrets for each receiver
ReceiverSecretStatus ReceiverConfigSecretStatusMap `json:"receiverSecretStatus,omitempty"`
// Alerts is the list of configured alerts
Alerts AlertConfigList `json:"alerts,omitempty"`
// AlertNames is the list of alert names that can be handled by Radix
AlertNames []string `json:"alertNames,omitempty"`
}
AlertingConfig current alert settings swagger:model AlertingConfig
type ReceiverConfig ¶
type ReceiverConfig struct {
// SlackConfig defines Slack configuration options for this receiver
// required: true
SlackConfig *SlackConfig `json:"slackConfig,omitempty"`
}
ReceiverConfig receiver configuration
type ReceiverConfigMap ¶
type ReceiverConfigMap map[string]ReceiverConfig
ReceiverConfigMap defines a map of ReceiverConfig where key is the name of the receiver
func (ReceiverConfigMap) AsRadixAlertReceiverMap ¶
func (m ReceiverConfigMap) AsRadixAlertReceiverMap() radixv1.ReceiverMap
AsRadixAlertReceiverMap converts map of ReceiverConfigs to map of Receivers to be used in RadixAlert spec
type ReceiverConfigSecretStatus ¶
type ReceiverConfigSecretStatus struct {
SlackConfig *SlackConfigSecretStatus `json:"slackConfig,omitempty"`
}
type ReceiverConfigSecretStatusMap ¶
type ReceiverConfigSecretStatusMap map[string]ReceiverConfigSecretStatus
ReceiverConfigSecretStatusMap defines a map of ReceiverConfigSecretStatus where key is the name of the receiver
type SlackConfig ¶
type SlackConfig struct {
// Enabled flag indicates if alert notifications should be sent to Slack
//
// required: true
Enabled bool `json:"enabled"`
}
SlackConfig configuration options for Slack
type SlackConfigSecretStatus ¶
type SlackConfigSecretStatus struct {
// WebhookURLConfigured flag indicates if a Slack webhook URL is set
WebhookURLConfigured bool `json:"webhookUrlConfigured"`
}
SlackConfigSecretStatus
type UpdateAlertingConfig ¶
type UpdateAlertingConfig struct {
// Receivers map of receivers
//
// required: true
Receivers ReceiverConfigMap `json:"receivers,omitempty"`
// ReceiverSecrets defines receiver secrets to be updated
//
// required: true
ReceiverSecrets UpdateReceiverConfigSecretsMap `json:"receiverSecrets,omitempty"`
// Alerts sets the list of alerts and mapping to a defined receiver
//
// required: true
Alerts AlertConfigList `json:"alerts"`
}
UpdateAlertingConfig contains fields for updating alert settings swagger:model UpdateAlertingConfig
type UpdateReceiverConfigSecrets ¶
type UpdateReceiverConfigSecrets struct {
// SlackConfig defines Slack secrets to update for this receiver
// Secrets will be updated if slackConfig is non-nil
SlackConfig *UpdateSlackConfigSecrets `json:"slackConfig"`
}
UpdateReceiverConfigSecrets defines secrets to be updated
type UpdateReceiverConfigSecretsMap ¶
type UpdateReceiverConfigSecretsMap map[string]UpdateReceiverConfigSecrets
UpdateReceiverConfigSecretsMap defines a map of UpdateReceiverConfigSecrets where key is the name of the receiver
type UpdateSlackConfigSecrets ¶
type UpdateSlackConfigSecrets struct {
// WebhookURL the Slack webhook URL where alerts are sent
// Secret key for webhook URL is updated if a non-nil value is present, and deleted if omitted or set to null
//
// required:
// Extensions:
// x-nullable: true
WebhookURL *string `json:"webhookUrl,omitempty"`
}
UpdateSlackConfig defines secrets to be updated for Slack