Skip to content
Snippets Groups Projects
  • Max Leonard Inden's avatar
    9e180452
    prometheus: Introduce RuleFile Custom Resource Definition · 9e180452
    Max Leonard Inden authored
    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.
    9e180452
    History
    prometheus: Introduce RuleFile Custom Resource Definition
    Max Leonard Inden authored
    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.