mirror of
https://github.com/prometheus-operator/prometheus-operator.git
synced 2025-04-16 01:06:27 +00:00
This patch introduces a new Custom Resource Definition to the Prometheus Operator - the Rule CRD. It addresses two main needs: 1. Prometheus (alerting and recording) Rule validation during creation time via Kubernetes Custom Resource Definition validation. 2. Life-cycle management of Prometheus application Rules alongside the application itself, inside the applications Kubernetes namespace, not necessarily the namespace of the scraping Prometheus instance. A user defines Prometheus alerting and recording Rules via a Kubernetes Custom Resource Definition. These Custom Resource Definitions can be fully validated by the Kubernetes API server during creation time via automatically generated OpenAPI specifications. Instead of the restriction of a Prometheus instance to only select Rule definitions inside its own namespace, the Prometheus specification is extended to also specify namespaces to look for Rule Custom Resource Definitions outside its own namespace. --- Dependent technical changes: - prometheus: Use github.com/jimmidyson/configmap-reload to reload rules - prometheus: Remove Prometheus Statefulset deletion function. Starting with K8s >=1.8 this is handled via OwnerReferences. - prometheus: Do not add rule files checksum to Prometheus configuration secret - prometheus: Update StatefulSet only on relevant changes. Instead of updating the Prometheus StatefulSet on every `sync()` run, only update it if the input parameters to `makeStatefulSet` change. Enforce this via a checksum of the parameters which is saved inside the annotations of the statefulset. - e2e/prometheus: Check how often resources (Secret, ConfigMap, Prometheus CRD, Service) are updated to enforce that Prometheus Operator only updated created resources if necessary. - contrib/prometheus-config-reloader: Remove logic to retriev K8s ConfigMaps. These are mounted into the pod right away now.
157 lines
4.8 KiB
Go
157 lines
4.8 KiB
Go
// Copyright 2016 The prometheus-operator Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package v1
|
|
|
|
import (
|
|
"fmt"
|
|
"k8s.io/apimachinery/pkg/runtime/schema"
|
|
"k8s.io/apimachinery/pkg/runtime/serializer"
|
|
"k8s.io/client-go/dynamic"
|
|
"k8s.io/client-go/kubernetes/scheme"
|
|
"k8s.io/client-go/rest"
|
|
"strings"
|
|
)
|
|
|
|
const (
|
|
Group = "monitoring.coreos.com"
|
|
PrometheusKindKey = "prometheus"
|
|
AlertManagerKindKey = "alertmanager"
|
|
ServiceMonitorKindKey = "servicemonitor"
|
|
RuleFileKindKey = "rulefile"
|
|
)
|
|
|
|
type CrdKind struct {
|
|
Kind string
|
|
Plural string
|
|
SpecName string
|
|
}
|
|
|
|
type CrdKinds struct {
|
|
KindsString string
|
|
Prometheus CrdKind
|
|
Alertmanager CrdKind
|
|
ServiceMonitor CrdKind
|
|
RuleFile CrdKind
|
|
}
|
|
|
|
var DefaultCrdKinds CrdKinds = CrdKinds{
|
|
KindsString: "",
|
|
Prometheus: CrdKind{Plural: PrometheusName, Kind: PrometheusesKind, SpecName: "github.com/coreos/prometheus-operator/pkg/client/monitoring/v1.Prometheus"},
|
|
ServiceMonitor: CrdKind{Plural: ServiceMonitorName, Kind: ServiceMonitorsKind, SpecName: "github.com/coreos/prometheus-operator/pkg/client/monitoring/v1.ServiceMonitor"},
|
|
Alertmanager: CrdKind{Plural: AlertmanagerName, Kind: AlertmanagersKind, SpecName: "github.com/coreos/prometheus-operator/pkg/client/monitoring/v1.Alertmanager"},
|
|
RuleFile: CrdKind{Plural: RuleFileName, Kind: RuleFilesKind, SpecName: "github.com/coreos/prometheus-operator/pkg/client/monitoring/v1.RuleFile"},
|
|
}
|
|
|
|
// Implement the flag.Value interface
|
|
func (crdkinds *CrdKinds) String() string {
|
|
return crdkinds.KindsString
|
|
}
|
|
|
|
// Set Implement the flag.Set interface
|
|
func (crdkinds *CrdKinds) Set(value string) error {
|
|
*crdkinds = DefaultCrdKinds
|
|
if value == "" {
|
|
value = fmt.Sprintf("%s=%s:%s,%s=%s:%s,%s=%s:%s,%s=%s:%s",
|
|
PrometheusKindKey, PrometheusesKind, PrometheusName,
|
|
AlertManagerKindKey, AlertmanagersKind, AlertmanagerName,
|
|
ServiceMonitorKindKey, ServiceMonitorsKind, ServiceMonitorName,
|
|
RuleFileKindKey, RuleFilesKind, RuleFileName,
|
|
)
|
|
}
|
|
splited := strings.Split(value, ",")
|
|
for _, pair := range splited {
|
|
sp := strings.Split(pair, "=")
|
|
kind := strings.Split(sp[1], ":")
|
|
crdKind := CrdKind{Plural: kind[1], Kind: kind[0]}
|
|
switch kindKey := sp[0]; kindKey {
|
|
case PrometheusKindKey:
|
|
(*crdkinds).Prometheus = crdKind
|
|
case ServiceMonitorKindKey:
|
|
(*crdkinds).ServiceMonitor = crdKind
|
|
case AlertManagerKindKey:
|
|
(*crdkinds).Alertmanager = crdKind
|
|
case RuleFileKindKey:
|
|
(*crdkinds).RuleFile = crdKind
|
|
default:
|
|
fmt.Printf("Warning: unknown kind: %s... ignoring", kindKey)
|
|
}
|
|
|
|
}
|
|
(*crdkinds).KindsString = value
|
|
return nil
|
|
}
|
|
|
|
var Version = "v1"
|
|
|
|
type MonitoringV1Interface interface {
|
|
RESTClient() rest.Interface
|
|
PrometheusesGetter
|
|
AlertmanagersGetter
|
|
ServiceMonitorsGetter
|
|
RuleFilesGetter
|
|
}
|
|
|
|
// +k8s:deepcopy-gen=false
|
|
type MonitoringV1Client struct {
|
|
restClient rest.Interface
|
|
dynamicClient *dynamic.Client
|
|
crdKinds *CrdKinds
|
|
}
|
|
|
|
func (c *MonitoringV1Client) Prometheuses(namespace string) PrometheusInterface {
|
|
return newPrometheuses(c.restClient, c.dynamicClient, c.crdKinds.Prometheus, namespace)
|
|
}
|
|
|
|
func (c *MonitoringV1Client) Alertmanagers(namespace string) AlertmanagerInterface {
|
|
return newAlertmanagers(c.restClient, c.dynamicClient, c.crdKinds.Alertmanager, namespace)
|
|
}
|
|
|
|
func (c *MonitoringV1Client) ServiceMonitors(namespace string) ServiceMonitorInterface {
|
|
return newServiceMonitors(c.restClient, c.dynamicClient, c.crdKinds.ServiceMonitor, namespace)
|
|
}
|
|
|
|
func (c *MonitoringV1Client) RuleFiles(namespace string) RuleFileInterface {
|
|
return newRuleFiles(c.restClient, c.dynamicClient, c.crdKinds.RuleFile, namespace)
|
|
}
|
|
|
|
func (c *MonitoringV1Client) RESTClient() rest.Interface {
|
|
return c.restClient
|
|
}
|
|
|
|
func NewForConfig(crdKinds *CrdKinds, apiGroup string, c *rest.Config) (*MonitoringV1Client, error) {
|
|
config := *c
|
|
SetConfigDefaults(apiGroup, &config)
|
|
client, err := rest.RESTClientFor(&config)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
dynamicClient, err := dynamic.NewClient(&config)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &MonitoringV1Client{client, dynamicClient, crdKinds}, nil
|
|
}
|
|
|
|
func SetConfigDefaults(apiGroup string, config *rest.Config) {
|
|
config.GroupVersion = &schema.GroupVersion{
|
|
Group: apiGroup,
|
|
Version: Version,
|
|
}
|
|
config.APIPath = "/apis"
|
|
config.NegotiatedSerializer = serializer.DirectCodecFactory{CodecFactory: scheme.Codecs}
|
|
return
|
|
}
|