alertmanager

Documentation

Index

• Constants
• Variables
• func CentralLoggingConfiguration() (component.CentralLoggingConfig, error)
• func GetLabels(name string) map[string]string
• type IngressValues
• type Interface
  • func New(log logr.Logger, client client.Client, namespace string, values Values) Interface
• type Values

Constants

const (

	// PortNameMetrics is the name of the metrics port.
	PortNameMetrics = "metrics"
)

Variables

var TimeoutWaitForManagedResource = 5 * time.Minute

TimeoutWaitForManagedResource is the timeout used while waiting for the ManagedResources to become healthy or deleted.

Functions

func CentralLoggingConfiguration

func CentralLoggingConfiguration() (component.CentralLoggingConfig, error)

CentralLoggingConfiguration returns a fluent-bit parser and filter for the alertmanager logs.

func GetLabels

func GetLabels(name string) map[string]string

GetLabels returns the labels for the given name.

Types

type IngressValues

type IngressValues struct {
	// AuthSecretName is the name of the auth secret.
	AuthSecretName string
	// Host is the hostname under which the AlertManager instance should be exposed.
	Host string
	// SecretsManager is the secrets manager used for generating the TLS certificate if no wildcard certificate is
	// provided.
	SecretsManager secretsmanager.Interface
	// SigningCA is the name of the CA that should be used to sign a self-signed server certificate. Only needed when
	// no wildcard certificate secret is provided.
	SigningCA string
	// WildcardCertSecretName is name of a secret containing the wildcard TLS certificate which is issued for the
	// ingress domain. If not provided, a self-signed server certificate will be created.
	WildcardCertSecretName *string
}

IngressValues contains configuration for exposing this AlertManager instance via an Ingress resource.

type Interface

type Interface interface {
	component.DeployWaiter
	// SetIngressAuthSecret sets the ingress authentication secret name.
	SetIngressAuthSecret(*corev1.Secret)
	// SetIngressWildcardCertSecret sets the ingress wildcard certificate secret name.
	SetIngressWildcardCertSecret(*corev1.Secret)
}

Interface contains functions for an alertmanager deployer.

func New

func New(log logr.Logger, client client.Client, namespace string, values Values) Interface

New creates a new instance of DeployWaiter for the AlertManager.

type Values

type Values struct {
	// Name is the name of the AlertManager. It will be used for the resource names of AlertManager and ManagedResource.
	Name string
	// Image defines the container image of AlertManager.
	Image string
	// Version is the version of AlertManager.
	Version string
	// ClusterType is the type of the cluster.
	ClusterType component.ClusterType
	// PriorityClassName is the name of the priority class for the StatefulSet.
	PriorityClassName string
	// StorageCapacity is the storage capacity of AlertManager.
	StorageCapacity resource.Quantity
	// Replicas is the number of replicas.
	Replicas int32
	// RuntimeVersion is the Kubernetes version of the runtime cluster.
	RuntimeVersion *semver.Version
	// AlertingSMTPSecret is the alerting SMTP secret.
	AlertingSMTPSecret *corev1.Secret
	// EmailReceivers is a list of email addresses to which alerts should be sent. If this list is empty, the alerts
	// will be sent to the email address in `.data.to` in the alerting SMTP secret.
	EmailReceivers []string
	// Ingress contains configuration for exposing this AlertManager instance via an Ingress resource.
	Ingress *IngressValues
}

Values contains configuration values for the AlertManager resources.