mla

Documentation

Overview

Package mla contains controllers that are responsible for configuring MLA (Monitoring, Logging, and Alerting) for user clusters. - org grafana controller - create/update/delete Grafana organizations based on Kubermatic Projects - user grafana controller - create/update/delete Grafana Users to organizations based on Kubermatic UserProjectBindings - datasource grafana controller - create/update/delete Grafana Datasources to organizations based on Kubermatic Clusters - alertmanager configuration controller - manage alertmanager configuration based on Kubermatic Clusters

Index

• Constants
• func Add(ctx context.Context, mgr manager.Manager, log *zap.SugaredLogger, ...) error
• func GatewayCACreator() reconciling.NamedSecretCreatorGetter
• func GatewayCertificateCreator(c *kubermaticv1.Cluster, ...) reconciling.NamedSecretCreatorGetter
• func GatewayConfigMapCreator(c *kubermaticv1.Cluster, mlaNamespace string, s *kubermaticv1.MLAAdminSetting) reconciling.NamedConfigMapCreatorGetter
• func GatewayDeploymentCreator(data *resources.TemplateData, settings *kubermaticv1.MLAAdminSetting) reconciling.NamedDeploymentCreatorGetter
• func GatewayExternalServiceCreator(c *kubermaticv1.Cluster) reconciling.NamedServiceCreatorGetter
• func GatewayInternalServiceCreator() reconciling.NamedServiceCreatorGetter
• func GetGrafanaOrgUser(ctx context.Context, grafanaClient *grafanasdk.Client, orgID, uid uint) (*grafanasdk.OrgUser, error)
• func ResourcesOnDeletion(clusterNamespace string) []ctrlruntimeclient.Object
• type Overrides
• type TenantOverride

Constants

const (
	AlertmanagerConfigEndpoint   = "/api/v1/alerts"
	AlertmanagerTenantHeaderName = "X-Scope-OrgID"
)

const (
	ControllerName = "kkp-mla-controller"

	GrafanaUserKey     = "admin-user"
	GrafanaPasswordKey = "admin-password"
)

const (
	RuntimeConfigMap      = "cortex-runtime-config"
	RuntimeConfigFileName = "runtime-config.yaml"
)

const (
	MetricsRuleGroupConfigEndpoint = "/api/v1/rules"
	LogRuleGroupConfigEndpoint     = "/loki/api/v1/rules"
	RuleGroupTenantHeaderName      = "X-Scope-OrgID"
)

const (
	GrafanaOrgAnnotationKey = "mla.k8c.io/organization"
)

const (
	PrometheusType = "prometheus"
)

Functions

func Add

func Add(
	ctx context.Context,
	mgr manager.Manager,
	log *zap.SugaredLogger,
	numWorkers int,
	workerName string,
	versions kubermatic.Versions,
	mlaNamespace string,
	grafanaURL string,
	grafanaHeader string,
	grafanaSecret string,
	overwriteRegistry string,
	cortexAlertmanagerURL string,
	cortexRulerURL string,
	lokiRulerURL string,
	mlaEnabled bool,
) error

Add creates a new MLA controller that is responsible for managing Monitoring, Logging and Alerting for user clusters. * org grafana controller - create/update/delete Grafana organizations based on Kubermatic Projects * user grafana controller - create/update/delete Grafana Global Users based on Kubermatic User and its Group/UserProjectBindings * datasource grafana controller - create/update/delete Grafana Datasources to organizations based on Kubermatic Clusters * alertmanager configuration controller - manage alertmanager configuration based on Kubermatic Clusters * rule group controller - manager rule groups that will be used to generate alerts. * dashboard grafana controller - create/delete Grafana dashboards based on configmaps with prefix `grafana-dashboards` * ratelimit cortex controller - updates Cortex runtime configuration with rate limits based on kubermatic MLAAdminSetting * cleanup controller - this controller runs when mla disabled and clean objects that left from other MLA controller.

func GatewayCACreator

func GatewayCACreator() reconciling.NamedSecretCreatorGetter

GatewayCACreator returns a function to create the ECDSA-based CA to be used for MLA Gateway.

func GatewayCertificateCreator

func GatewayCertificateCreator(c *kubermaticv1.Cluster, mlaGatewayCAGetter func() (*resources.ECDSAKeyPair, error)) reconciling.NamedSecretCreatorGetter

GatewayCertificateCreator returns a function to create/update a secret with the MLA gateway TLS certificate.

func GatewayConfigMapCreator

func GatewayConfigMapCreator(c *kubermaticv1.Cluster, mlaNamespace string, s *kubermaticv1.MLAAdminSetting) reconciling.NamedConfigMapCreatorGetter

func GatewayDeploymentCreator

func GatewayDeploymentCreator(data *resources.TemplateData, settings *kubermaticv1.MLAAdminSetting) reconciling.NamedDeploymentCreatorGetter

func GatewayExternalServiceCreator

func GatewayExternalServiceCreator(c *kubermaticv1.Cluster) reconciling.NamedServiceCreatorGetter

func GatewayInternalServiceCreator

func GatewayInternalServiceCreator() reconciling.NamedServiceCreatorGetter

func GetGrafanaOrgUser

func GetGrafanaOrgUser(ctx context.Context, grafanaClient *grafanasdk.Client, orgID, uid uint) (*grafanasdk.OrgUser, error)

func ResourcesOnDeletion

func ResourcesOnDeletion(clusterNamespace string) []ctrlruntimeclient.Object

Types

type Overrides

type Overrides struct {
	Overrides map[string]TenantOverride `yaml:"overrides"`
}

type TenantOverride

type TenantOverride struct {
	IngestionRate      *int32 `yaml:"ingestion_rate,omitempty"`
	MaxSeriesPerMetric *int32 `yaml:"max_series_per_metric,omitempty"`
	MaxSeriesPerQuery  *int32 `yaml:"max_series_per_query,omitempty"`
	MaxSamplesPerQuery *int32 `yaml:"max_samples_per_query,omitempty"`
	IngestionBurstSize *int32 `yaml:"ingestion_burst_size,omitempty"`
	MaxSeriesTotal     *int32 `yaml:"max_series_per_user,omitempty"`
}